Skip to content

adding python version and deps requirements #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

adding python version and deps requirements #22

wants to merge 1 commit into from

Conversation

@Tosinibikunle
Copy link

@Tosinibikunle Tosinibikunle commented Oct 18, 2025 •
edited by qodo-merge-pro bot
Loading

User description

resolves #20.

PR Type

Documentation

Description

  • Added Python version requirement (3.8+) documentation

  • Documented core dependency typing-extensions for Python < 3.11

  • Added comprehensive optional dependencies table with extras

  • Organized optional integrations by category (cloud, monitoring, performance)

Diagram Walkthrough

flowchart LR
  A["README.md"] -->|"Add Requirements Section"| B["Python 3.8+ requirement"]
  A -->|"Add Core Dependencies"| C["typing-extensions for Python < 3.11"]
  A -->|"Add Optional Dependencies Table"| D["Cloud, Monitoring, Performance extras"]
Loading

File Walkthrough
Relevant files
Documentation
README.md
Document Python version and dependency requirements           

README.md

  • Added "Requirements" section specifying Python 3.8 or higher
  • Documented core dependency typing-extensions>=4.0.0 for Python < 3.11
  • Added comprehensive "Optional Dependencies" table with 13 integration
    options
  • Organized extras by category: cloud platforms, monitoring tools,
    performance, development, and all-in-one options
 +28/-0   

@qodo-merge-pro
Copy link

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟢
🎫 #20
🟢 Update README installation section to clearly state the minimum supported Python version.
Document required dependencies needed for functionality.
Document optional dependencies/extras for full functionality and integrations.
Codebase Duplication Compliance
⚪
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
⚪
No custom compliance provided

Follow the guide to enable custom compliance check.
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-merge-pro
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
High-level
Automate dependency documentation from configuration

The manually created dependency table in the README should be automatically
generated from the project's packaging configuration file (e.g.,
pyproject.toml). This ensures the documentation remains accurate and reduces
maintenance.

Examples:

README.md [105-123] 
### Optional Dependencies

MickTrace provides several optional integrations that can be installed with extras:

| AWS CloudWatch | `aws` | `aioboto3>=11.3.0`, `botocore>=1.31.62` |
| Azure Monitor | `azure` | `azure-monitor-ingestion>=1.0.0b5`, `azure-core>=1.29.5` |
| Google Cloud Logging | `gcp` | `google-cloud-logging>=3.8.0` |
| All Cloud Platforms | `cloud` | includes all cloud dependencies (`aws`, `azure`, `gcp`) |
| Datadog Integration | `datadog` | `datadog>=0.44.0`, `requests>=2.28.0` |
| New Relic Monitoring | `newrelic` | `newrelic>=8.0.0` |

 ... (clipped 9 lines)

Solution Walkthrough:

Before:

# In README.md (manual entry)

### Optional Dependencies
MickTrace provides several optional integrations...

| AWS CloudWatch | `aws` | `aioboto3>=11.3.0`, `botocore>=1.31.62` |
| Azure Monitor | `azure` | `azure-monitor-ingestion>=1.0.0b5`, `azure-core>=1.29.5` |
| ... | ... | ... |
| All Integrations | `all` | includes all optional dependencies |

After:

# In pyproject.toml (single source of truth)
[project.optional-dependencies]
aws = ["aioboto3>=11.3.0", "botocore>=1.31.62"]
azure = ["azure-monitor-ingestion>=1.0.0b5", "azure-core>=1.29.5"]
# ...

# In a build/docs script (e.g., update_readme.py)
def generate_deps_table():
    # 1. Parse pyproject.toml to get optional-dependencies
    # 2. Format data into a Markdown table
    # 3. Inject the table into README.md using markers
    pass

# In README.md
<!-- DEPS_TABLE_START -->
(This content is auto-generated by a script)
<!-- DEPS_TABLE_END -->
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a significant long-term maintainability risk with the manually added dependency table and proposes a robust automation solution, which is a best practice.

Medium
General
Avoid dependency on pre-release package

Update the azure-monitor-ingestion dependency from the pre-release version
1.0.0b5 to the stable version 1.0.0 to improve stability.

README.md [110]

-| Azure Monitor | `azure` | `azure-monitor-ingestion>=1.0.0b5`, `azure-core>=1.29.5` |
+| Azure Monitor | `azure` | `azure-monitor-ingestion>=1.0.0`, `azure-core>=1.29.5` |
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies a dependency on a pre-release package and recommends using a stable version, which is a best practice for ensuring reliability.

Low
Remove redundant transitive dependency declaration

Remove the redundant requests dependency from the datadog extra, as it is
already included as a transitive dependency of the datadog package.

README.md [113]

-| Datadog Integration | `datadog` | `datadog>=0.44.0`, `requests>=2.28.0` |
+| Datadog Integration | `datadog` | `datadog>=0.44.0` |
  • Apply / Chat
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies a redundant transitive dependency, and removing it simplifies the dependency list and improves maintainability.

Low
  • More

@ajayagrawalgit
Copy link
Owner

Hi @Tosinibikunle,

Thank you for taking the time to contribute to MickTrace and helping improve the project.

This issue aims to expand the installation instructions into a dedicated, clearly defined section that developers can easily follow when setting up MickTrace locally—whether for feature enhancements or other contributions. The goal is to include a comprehensive, step-by-step setup guide, ideally within a separate file. This addition will also serve as valuable content for the Installation tab on the MickTrace GitHub Pages site, which is currently under development.

I understand that the initial issue description might not have fully conveyed this scope, but I’ll ensure it’s updated with refined expectations to support any valuable contributions moving forward.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Review effort 1/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add Detailed Local Installation Guide with Real-Time Snippets

2 participants

@Tosinibikunle @ajayagrawalgit